<html>
<head>
<title>Docs For Class Authentication</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">default</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
        
                                    
                              		  [ <a href="../classtrees_default.html" class="menu">class tree: default</a> ]
		  [ <a href="../elementindex_default.html" class="menu">index: default</a> ]
		  	    [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="200" class="menu">
      <b>Packages:</b><br />
              <a href="../li_default.html">default</a><br />
            <br /><br />
                        <b>Files:</b><br />
      	  <div class="package">
			<a href="../default/_ACS---Authentication.php.html">		Authentication.php
		</a><br>
			<a href="../default/_ServiceBus---constants.inc.html">		constants.inc
		</a><br>
			<a href="../default/_util---curlRequest.php.html">		curlRequest.php
		</a><br>
			<a href="../default/_DotNetServicesEnvironment.php.html">		DotNetServicesEnvironment.php
		</a><br>
			<a href="../default/_util---HttpHelper.php.html">		HttpHelper.php
		</a><br>
			<a href="../default/_util---HttpWebProxy.php.html">		HttpWebProxy.php
		</a><br>
			<a href="../default/_util---LoggerClass.php.html">		LoggerClass.php
		</a><br>
			<a href="../default/_ServiceBus---MessageBufferClient.php.html">		MessageBufferClient.php
		</a><br>
			<a href="../default/_ServiceBus---MessageBufferPolicy.php.html">		MessageBufferPolicy.php
		</a><br>
			<a href="../default/_ACS---SAML.php.html">		SAML.php
		</a><br>
			<a href="../default/_ACS---Scope.php.html">		Scope.php
		</a><br>
			<a href="../default/_ServiceBus---ServiceBusConfig.php.html">		ServiceBusConfig.php
		</a><br>
			<a href="../default/_ACS---SharedSecret.php.html">		SharedSecret.php
		</a><br>
			<a href="../default/_ACS---SimpleApiAuthService.php.html">		SimpleApiAuthService.php
		</a><br>
			<a href="../default/_ACS---SWT.php.html">		SWT.php
		</a><br>
			<a href="../default/_ACS---TokenValidator.php.html">		TokenValidator.php
		</a><br>
			<a href="../default/_util---ValidateClaimUtil.php.html">		ValidateClaimUtil.php
		</a><br>
	  </div><br />
      
      
            <b>Classes:</b><br />
        <div class="package">
		    		<a href="../default/Authentication.html">Authentication</a><br />
	    		<a href="../default/CurlRequest.html">CurlRequest</a><br />
	    		<a href="../default/DotNetServicesEnvironment.html">DotNetServicesEnvironment</a><br />
	    		<a href="../default/HttpHelper.html">HttpHelper</a><br />
	    		<a href="../default/HttpWebProxy.html">HttpWebProxy</a><br />
	    		<a href="../default/LoggerClass.html">LoggerClass</a><br />
	    		<a href="../default/MessageBufferClient.html">MessageBufferClient</a><br />
	    		<a href="../default/MessageBufferPolicy.html">MessageBufferPolicy</a><br />
	    		<a href="../default/SAML.html">SAML</a><br />
	    		<a href="../default/Scope.html">Scope</a><br />
	    		<a href="../default/ServiceBusConfig.html">ServiceBusConfig</a><br />
	    		<a href="../default/SharedSecret.html">SharedSecret</a><br />
	    		<a href="../default/SimpleApiAuthService.html">SimpleApiAuthService</a><br />
	    		<a href="../default/SWT.html">SWT</a><br />
	    		<a href="../default/TokenValidator.html">TokenValidator</a><br />
	    		<a href="../default/ValidateClaimUtil.html">ValidateClaimUtil</a><br />
	  </div>
                </td>
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: Authentication</h1>
Source Location: /ACS/Authentication.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description">Authentication Class</div><br /><br />
<h4>Author(s):</h4>
<ul>
        </ul>




    

        
</td>

<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
    <li><a href="../default/Authentication.html#var$ServiceName">$ServiceName</a></li>
  </ul>
</td>


<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../default/Authentication.html#method__construct">__construct</a></li>
    <li><a href="../default/Authentication.html#methodgetAcmHostName">getAcmHostName</a></li>
    <li><a href="../default/Authentication.html#methodgetACSToken">getACSToken</a></li>
    <li><a href="../default/Authentication.html#methodgetHttpWebProxy">getHttpWebProxy</a></li>
    <li><a href="../default/Authentication.html#methodgetScope">getScope</a></li>
    <li><a href="../default/Authentication.html#methodgetServiceName">getServiceName</a></li>
    <li><a href="../default/Authentication.html#methodsetAcmHostName">setAcmHostName</a></li>
    <li><a href="../default/Authentication.html#methodsetHttpWebProxy">setHttpWebProxy</a></li>
    <li><a href="../default/Authentication.html#methodsetScope">setScope</a></li>
    <li><a href="../default/Authentication.html#methodsetServiceName">setServiceName</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>


<td valign="top">
<h3>Child classes:</h3>
<div class="tags">
<dl>
<dt><a href="../default/SAML.html">SAML</a></dt>
	<dd>Class SAML For getting SAML Token</dd>
</dl>
<dl>
<dt><a href="../default/SharedSecret.html">SharedSecret</a></dt>
	<dd>Class SharedSecret For getting SharedSecret Token</dd>
</dl>
<dl>
<dt><a href="../default/SimpleApiAuthService.html">SimpleApiAuthService</a></dt>
	<dd>Class SimpleApiAuthService For getting SimpleApiAuthService Token</dd>
</dl>
<dl>
<dt><a href="../default/SWT.html">SWT</a></dt>
	<dd>Class SWT For getting SWT Token</dd>
</dl>
</div>
</td>




</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 39]<br />
Authentication Class<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>abstract:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
</table>
</div>
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />

<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
	<a name="var$ServiceName"></a>
	<p></p>
	<h4>static $ServiceName = <span class="value">&nbsp;&quot;WRAPv0.8&quot;</span></h4>
	<p>[line 70]</p>
  a static variable service name<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>mixed</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">

  <hr />
	<a name="method__construct"></a>
	<h3>constructor __construct <span class="smalllinenumber">[line 77]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>Authentication __construct(
string
$acmHostName, string
$serviceName)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the member variables<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../default/SAML.html#method__construct">SAML::__construct()</a></dt>
		<dd>constructor</dd>
	</dl>
		<dl>
	<dt><a href="../default/SharedSecret.html#method__construct">SharedSecret::__construct()</a></dt>
		<dd>Sets the member variables</dd>
	</dl>
		<dl>
	<dt><a href="../default/SimpleApiAuthService.html#method__construct">SimpleApiAuthService::__construct()</a></dt>
		<dd>Sets the member variables</dd>
	</dl>
		<dl>
	<dt><a href="../default/SWT.html#method__construct">SWT::__construct()</a></dt>
		<dd>constructor</dd>
	</dl>
	</p>
	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$acmHostName</b>&nbsp;&nbsp;</td>
        <td>It is the ACM host name</td>
      </tr>
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$serviceName</b>&nbsp;&nbsp;</td>
        <td>It is the service name.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetAcmHostName"></a>
	<h3>method getAcmHostName <span class="smalllinenumber">[line 136]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>AcmHostName getAcmHostName(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Gets the scope object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>name</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetACSToken"></a>
	<h3>method getACSToken <span class="smalllinenumber">[line 83]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void getACSToken(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		<br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>abstract:</b>&nbsp;&nbsp;</td><td></td>
  </tr>
</table>
</div>
<br /><br />

	<p>Overridden in child classes as:<br />
		<dl>
	<dt><a href="../default/SAML.html#methodgetACSToken">SAML::getACSToken()</a></dt>
		<dd>Get access token</dd>
	</dl>
		<dl>
	<dt><a href="../default/SharedSecret.html#methodgetACSToken">SharedSecret::getACSToken()</a></dt>
		<dd>Get SharedSecret token</dd>
	</dl>
		<dl>
	<dt><a href="../default/SimpleApiAuthService.html#methodgetACSToken">SimpleApiAuthService::getACSToken()</a></dt>
		<dd>Sets the scope object</dd>
	</dl>
		<dl>
	<dt><a href="../default/SWT.html#methodgetACSToken">SWT::getACSToken()</a></dt>
		<dd>Get access token</dd>
	</dl>
	</p>
	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetHttpWebProxy"></a>
	<h3>method getHttpWebProxy <span class="smalllinenumber">[line 99]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>object getHttpWebProxy(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Gets the proxy object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>It is object of Proxy class</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetScope"></a>
	<h3>method getScope <span class="smalllinenumber">[line 117]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>object getScope(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the scope object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>return:</b>&nbsp;&nbsp;</td><td>It is the object of class cope</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetServiceName"></a>
	<h3>method getServiceName <span class="smalllinenumber">[line 154]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>serviceName getServiceName(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Gets the Service Name<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetAcmHostName"></a>
	<h3>method setAcmHostName <span class="smalllinenumber">[line 127]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setAcmHostName(
$acmHostName
$acmHostName)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the AcmHostName<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">$acmHostName&nbsp;&nbsp;</td>
        <td><b>$acmHostName</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetHttpWebProxy"></a>
	<h3>method setHttpWebProxy <span class="smalllinenumber">[line 89]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setHttpWebProxy(
object
$httpWebProxy)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the proxy object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$httpWebProxy</b>&nbsp;&nbsp;</td>
        <td>It is object of Proxy class</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetScope"></a>
	<h3>method setScope <span class="smalllinenumber">[line 108]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setScope(
object
$scope)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the scope object<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$scope</b>&nbsp;&nbsp;</td>
        <td>It is the object of class scope</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetServiceName"></a>
	<h3>method setServiceName <span class="smalllinenumber">[line 145]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setServiceName(
$serviceName
$serviceName)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets the Service Name<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
</table>
</div>
<br /><br />

	
        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">$serviceName&nbsp;&nbsp;</td>
        <td><b>$serviceName</b>&nbsp;&nbsp;</td>
        <td></td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Sat, 07 Nov 2009 01:40:47 +0000 by <a href="http://www.phpdoc.org">phpDocumentor 1.4.3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>